STU 3 Candidate

This page is part of the FHIR Specification (v1.4.0: STU 3 Ballot 3). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

A.11.1.0 StructureDefinition: USLab-Spec

The official URL for this profile is: 

http://hl7.org/fhir/StructureDefinition/uslab-spec

USLab Specimen Resource

This profile was published on Mon, Nov 17, 2014 00:00+1100 as a draft by Health Level Seven International (Orders and Observations - US Lab).

A.11.1.0.1 Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.

This structure is derived from Specimen.

Summary

Mandatory: 11 elements (+6 nested mandatory elements)
Must-Support: 23 elements
Fixed Value: 2 elements

Structures

This structure refers to these other structures:

This structure is derived from Specimen.

NameFlagsCard.TypeDescription & Constraintsdoco
.. Specimen 0..*SpecimenUSLab Specimen Resource
... identifier S0..*Identifier
.... use S1..1codeFixed Value: official
.... system S1..1uriPlacer URI
.... value S1..1stringPlacer Identifier
... accessionIdentifier S1..1Identifier
.... use S1..1codeFixed Value: official
.... system S1..1uriFiller URI
.... value S1..1stringFiller Identifier
... type S1..1CodeableConceptBinding: USLab Specimen Type (extensible)
.... coding S1..*Coding
..... system S1..1uri
..... code S1..1code
..... display S0..1string
.... text S0..1stringDisplay text
... subject S1..1Reference(US Laboratory Patient Profile | US Laboratory Patient Profile)Patient
... collection S1..1BackboneElement
.... collected[x] S I1..1dateTime, Periodinv-2: Datetime must be at least to the day.
.... bodySite S0..1CodeableConceptBinding: USLab Specimen Body Site (extensible)
..... coding S1..*Coding
...... system S1..1uri
...... code S1..1code
...... display S0..1string
..... text S0..1stringDisplay text

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Specimen 0..*SpecimenUSLab Specimen Resource
... meta ∑0..1MetaMetadata about the resource
... implicitRules ?! ∑0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: IETF BCP-47 (required)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional Content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier S ∑0..*IdentifierExternal Identifier
.... extension 0..*ExtensionAdditional Content defined by implementations
.... use ?! S∑1..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required)
Fixed Value: official
.... type ∑0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
.... system S ∑1..1uriPlacer URI
Example: http://www.acme.com/identifiers/patient or urn:ietf:rfc:3986 if the Identifier.value itself is a full uri
.... value S ∑1..1stringPlacer Identifier
Example: 123456
.... period ∑0..1PeriodTime period when id is/was valid for use
.... assigner ∑0..1Reference(Organization)Organization that issued id (may be just text)
... accessionIdentifier S ∑1..1IdentifierIdentifier assigned by the lab
.... extension 0..*ExtensionAdditional Content defined by implementations
.... use ?! S∑1..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required)
Fixed Value: official
.... type ∑0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
.... system S ∑1..1uriFiller URI
Example: http://www.acme.com/identifiers/patient or urn:ietf:rfc:3986 if the Identifier.value itself is a full uri
.... value S ∑1..1stringFiller Identifier
Example: 123456
.... period ∑0..1PeriodTime period when id is/was valid for use
.... assigner ∑0..1Reference(Organization)Organization that issued id (may be just text)
... status ?! ∑0..1codeavailable | unavailable | unsatisfactory | entered-in-error
Binding: SpecimenStatus (required)
... type S ∑1..1CodeableConceptKind of material that forms the specimen
Binding: USLab Specimen Type (extensible)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... coding S ∑1..*CodingCode defined by a terminology system
..... extension 0..*ExtensionAdditional Content defined by implementations
..... system S ∑1..1uriIdentity of the terminology system
..... version ∑0..1stringVersion of the system - if relevant
..... code S ∑1..1codeSymbol in syntax defined by the system
..... display S ∑0..1stringRepresentation defined by the system
..... userSelected ∑0..1booleanIf this coding was chosen directly by the user
.... text S ∑0..1stringDisplay text
... subject S ∑1..1Reference(US Laboratory Patient Profile | US Laboratory Patient Profile)Patient
... receivedTime ∑0..1dateTimeThe time when specimen was received for processing
... parent 0..*Reference(Specimen)Specimen from which this specimen originated
... collection S1..1BackboneElementCollection details
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?! ∑0..*ExtensionExtensions that cannot be ignored
.... collector ∑0..1Reference(Practitioner)Who collected the specimen
.... comment 0..1stringCollector comments
.... collected[x] S ∑I1..1dateTime, PeriodCollection time
inv-2: Datetime must be at least to the day.
.... quantity 0..1SimpleQuantityThe quantity of specimen collected
.... method 0..1CodeableConceptTechnique used to perform collection
Binding: SpecimenCollectionMethod (example)
.... bodySite S0..1CodeableConceptAnatomical collection site
Binding: USLab Specimen Body Site (extensible)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... coding S ∑1..*CodingCode defined by a terminology system
...... extension 0..*ExtensionAdditional Content defined by implementations
...... system S ∑1..1uriIdentity of the terminology system
...... version ∑0..1stringVersion of the system - if relevant
...... code S ∑1..1codeSymbol in syntax defined by the system
...... display S ∑0..1stringRepresentation defined by the system
...... userSelected ∑0..1booleanIf this coding was chosen directly by the user
..... text S ∑0..1stringDisplay text
... treatment 0..*BackboneElementTreatment and processing step details
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?! ∑0..*ExtensionExtensions that cannot be ignored
.... description 0..1stringTextual description of procedure
.... procedure 0..1CodeableConceptIndicates the treatment or processing step applied to the specimen
Binding: SpecimenTreatmentProcedure (example)
.... additive 0..*Reference(Substance)Material used in the processing step
... container 0..*BackboneElementDirect container of specimen (tube/slide, etc.)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?! ∑0..*ExtensionExtensions that cannot be ignored
.... identifier ∑0..*IdentifierId for the container
.... description 0..1stringTextual description of the container
.... type 0..1CodeableConceptKind of container directly associated with specimen
Binding: SpecimenContainer (example)
.... capacity 0..1SimpleQuantityContainer volume or size
.... specimenQuantity 0..1SimpleQuantityQuantity of specimen within container
.... additive[x] 0..1CodeableConcept, Reference(Substance)Additive associated with container
Binding: v2 Additive/Preservative (example)

doco Documentation for this format

todo

This structure is derived from Specimen.

Summary

Mandatory: 11 elements (+6 nested mandatory elements)
Must-Support: 23 elements
Fixed Value: 2 elements

Structures

This structure refers to these other structures:

Differential View

This structure is derived from Specimen.

NameFlagsCard.TypeDescription & Constraintsdoco
.. Specimen 0..*SpecimenUSLab Specimen Resource
... identifier S0..*Identifier
.... use S1..1codeFixed Value: official
.... system S1..1uriPlacer URI
.... value S1..1stringPlacer Identifier
... accessionIdentifier S1..1Identifier
.... use S1..1codeFixed Value: official
.... system S1..1uriFiller URI
.... value S1..1stringFiller Identifier
... type S1..1CodeableConceptBinding: USLab Specimen Type (extensible)
.... coding S1..*Coding
..... system S1..1uri
..... code S1..1code
..... display S0..1string
.... text S0..1stringDisplay text
... subject S1..1Reference(US Laboratory Patient Profile | US Laboratory Patient Profile)Patient
... collection S1..1BackboneElement
.... collected[x] S I1..1dateTime, Periodinv-2: Datetime must be at least to the day.
.... bodySite S0..1CodeableConceptBinding: USLab Specimen Body Site (extensible)
..... coding S1..*Coding
...... system S1..1uri
...... code S1..1code
...... display S0..1string
..... text S0..1stringDisplay text

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Specimen 0..*SpecimenUSLab Specimen Resource
... meta ∑0..1MetaMetadata about the resource
... implicitRules ?! ∑0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: IETF BCP-47 (required)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional Content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier S ∑0..*IdentifierExternal Identifier
.... extension 0..*ExtensionAdditional Content defined by implementations
.... use ?! S∑1..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required)
Fixed Value: official
.... type ∑0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
.... system S ∑1..1uriPlacer URI
Example: http://www.acme.com/identifiers/patient or urn:ietf:rfc:3986 if the Identifier.value itself is a full uri
.... value S ∑1..1stringPlacer Identifier
Example: 123456
.... period ∑0..1PeriodTime period when id is/was valid for use
.... assigner ∑0..1Reference(Organization)Organization that issued id (may be just text)
... accessionIdentifier S ∑1..1IdentifierIdentifier assigned by the lab
.... extension 0..*ExtensionAdditional Content defined by implementations
.... use ?! S∑1..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required)
Fixed Value: official
.... type ∑0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
.... system S ∑1..1uriFiller URI
Example: http://www.acme.com/identifiers/patient or urn:ietf:rfc:3986 if the Identifier.value itself is a full uri
.... value S ∑1..1stringFiller Identifier
Example: 123456
.... period ∑0..1PeriodTime period when id is/was valid for use
.... assigner ∑0..1Reference(Organization)Organization that issued id (may be just text)
... status ?! ∑0..1codeavailable | unavailable | unsatisfactory | entered-in-error
Binding: SpecimenStatus (required)
... type S ∑1..1CodeableConceptKind of material that forms the specimen
Binding: USLab Specimen Type (extensible)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... coding S ∑1..*CodingCode defined by a terminology system
..... extension 0..*ExtensionAdditional Content defined by implementations
..... system S ∑1..1uriIdentity of the terminology system
..... version ∑0..1stringVersion of the system - if relevant
..... code S ∑1..1codeSymbol in syntax defined by the system
..... display S ∑0..1stringRepresentation defined by the system
..... userSelected ∑0..1booleanIf this coding was chosen directly by the user
.... text S ∑0..1stringDisplay text
... subject S ∑1..1Reference(US Laboratory Patient Profile | US Laboratory Patient Profile)Patient
... receivedTime ∑0..1dateTimeThe time when specimen was received for processing
... parent 0..*Reference(Specimen)Specimen from which this specimen originated
... collection S1..1BackboneElementCollection details
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?! ∑0..*ExtensionExtensions that cannot be ignored
.... collector ∑0..1Reference(Practitioner)Who collected the specimen
.... comment 0..1stringCollector comments
.... collected[x] S ∑I1..1dateTime, PeriodCollection time
inv-2: Datetime must be at least to the day.
.... quantity 0..1SimpleQuantityThe quantity of specimen collected
.... method 0..1CodeableConceptTechnique used to perform collection
Binding: SpecimenCollectionMethod (example)
.... bodySite S0..1CodeableConceptAnatomical collection site
Binding: USLab Specimen Body Site (extensible)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... coding S ∑1..*CodingCode defined by a terminology system
...... extension 0..*ExtensionAdditional Content defined by implementations
...... system S ∑1..1uriIdentity of the terminology system
...... version ∑0..1stringVersion of the system - if relevant
...... code S ∑1..1codeSymbol in syntax defined by the system
...... display S ∑0..1stringRepresentation defined by the system
...... userSelected ∑0..1booleanIf this coding was chosen directly by the user
..... text S ∑0..1stringDisplay text
... treatment 0..*BackboneElementTreatment and processing step details
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?! ∑0..*ExtensionExtensions that cannot be ignored
.... description 0..1stringTextual description of procedure
.... procedure 0..1CodeableConceptIndicates the treatment or processing step applied to the specimen
Binding: SpecimenTreatmentProcedure (example)
.... additive 0..*Reference(Substance)Material used in the processing step
... container 0..*BackboneElementDirect container of specimen (tube/slide, etc.)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?! ∑0..*ExtensionExtensions that cannot be ignored
.... identifier ∑0..*IdentifierId for the container
.... description 0..1stringTextual description of the container
.... type 0..1CodeableConceptKind of container directly associated with specimen
Binding: SpecimenContainer (example)
.... capacity 0..1SimpleQuantityContainer volume or size
.... specimenQuantity 0..1SimpleQuantityQuantity of specimen within container
.... additive[x] 0..1CodeableConcept, Reference(Substance)Additive associated with container
Binding: v2 Additive/Preservative (example)

doco Documentation for this format

XML Template

JSON Template

todo

 

Other representations of profile: Schematron

A.11.1.0.2 Terminology Bindings

PathNameConformanceValueSet
Specimen.language?extrequiredhttp://tools.ietf.org/html/bcp47
Specimen.identifier.useIdentifierUserequiredIdentifierUse
Specimen.identifier.typeIdentifier Type CodesextensibleIdentifier Type Codes
Specimen.accessionIdentifier.useIdentifierUserequiredIdentifierUse
Specimen.accessionIdentifier.typeIdentifier Type CodesextensibleIdentifier Type Codes
Specimen.statusSpecimenStatusrequiredSpecimenStatus
Specimen.typeUSLab Specimen TypeextensibleUSLab Specimen Type
Specimen.collection.methodSpecimenCollectionMethodexampleSpecimenCollectionMethod
Specimen.collection.bodySiteUSLab Specimen Body SiteextensibleUSLab Specimen Body Site
Specimen.treatment.procedureSpecimenTreatmentProcedureexampleSpecimenTreatmentProcedure
Specimen.container.typeSpecimenContainerexampleSpecimenContainer
Specimen.container.additive[x]v2 Additive/Preservativeexamplev2 Additive/Preservative

A.11.1.0.3 Constraints

IdPathDetailsRequirements
inv-2Specimen.collection.collected[x]Datetime must be at least to the day.
XPath: f:matches(.,/\d{4}-[01]\d-[0-3])/)
.